/*
 *  This file is part of LifeBudget - Copyright 2010 Clifton Eaton
 *  ------------------------------------------------------------------
 *  LifeBudget is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  LifeBudget is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with LifeBudget.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.lifebudget.app.client.mvc.model;

import org.lifebudget.app.client.mvc.view.paycheck.PaycheckCalculatorSummaryView;

/**
 * The Class PaycheckSummary is contains the data used by the 
 * {@link PaycheckCalculatorSummaryView} to hold the current state
 * of the {@link PaycheckCalculator}.
 * 
 * Serves as model object to the view as well as a Data Transfer Object and 
 * therefore, meant to be used only in the client code or for communicating 
 * to through GWT RPC. 
 */
public class PaycheckSummary {
	
	/** The estimated amount. */
	private double estimatedAmt;
	
	/** The used amount. */
	private double usedAmt;

	/**
	 * Instantiates a new paycheck summary.
	 */
	public PaycheckSummary() {

	}

	/**
	 * Sets the estimated amount.
	 *
	 * @param estimatedAmt the new estimated amount
	 */
	public void setEstimatedAmt(double estimatedAmt) {
		this.estimatedAmt = estimatedAmt;
	}

	/**
	 * Gets the estimated amount.
	 *
	 * @return the estimated amount
	 */
	public double getEstimatedAmt() {
		return estimatedAmt;
	}

	/**
	 * Sets the used amount.
	 *
	 * @param usedAmt the new used amount
	 */
	public void setUsedAmt(double usedAmt) {
		this.usedAmt = usedAmt;
	}

	/**
	 * Gets the used amount.
	 *
	 * @return the used amount
	 */
	public double getUsedAmt() {
		return usedAmt;
	}

	/**
	 * Gets the remaining amount.
	 *
	 * @return the remaining amount
	 */
	public double getRemainingAmt() {
		return estimatedAmt - usedAmt;
	}

}
